Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive help documentation to gimmegit, expanding the help output from a basic usage summary to a detailed guide covering all features and options.
Key changes:
- Expanded help text from ~20 lines to ~92 lines with detailed sections for usage, arguments, options, and examples
- Updated error message wording for clarity ("contains" instead of "has")
- Corrected capitalization of "Git" in documentation
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/gimmegit/_help.py | Complete rewrite of help text with comprehensive documentation including usage patterns, directory structure, branch mapping, options, and examples |
| src/gimmegit/_cli.py | Updated error message to use "contains" instead of "has" for clarity |
| tests/functional/test_clone.py | Updated test expectation to match the new error message wording |
| README.md | Standardized capitalization of "Git" and improved formatting of multi-line command examples |
Owner
Author
|
@copilot let's add a step to the "checks" CI that checks that the help output in README.md matches the output of
|
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR expands the output of
gimmegit -hwith an essentially complete summary of how thegimmegitcommand works. I've duplicated the help output in the README and added an automatic check that the README is up-to-date.